/* Copyright 2009
 *
 * This program and the accompanying materials
 * are made available under the terms of the
 * Eclipse Public License v1.0 which accompanies
 * this distribution, and is available at
 *
 * 		http://www.eclipse.org/legal/epl-v10.html
 *
 * Unless required by applicable law or agreed to in
 * writing, software distributed under the License is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 * OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * Contributors:
 * 	   IBM Corporation - initial API and implementation for JDT/DLTK
 *     Sean W. Quinn - initial adoption for use with PHP from various sources.
 */
package org.eclipse.php.internal.ui.widgets;

import org.eclipse.php.internal.ui.PHPUiPluginExt;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.part.PageBook;

/**
 * This component switches between the two views and is responsible for
 * delegating the appropriate update requests.
 *
 * @author Sean W. Quinn (swquinn@gmail.com)
 */
abstract public class SwitchComponent extends SelectionAdapter {

	protected final String PREF_VIEW_KEY= PHPUiPluginExt.PLUGIN_ID + "formatter_page.white_space_tab_page.view"; //$NON-NLS-1$

	private Combo switchCombo;
	private PageBook pageBook;
	private final ISyntaxComponent syntaxComponent;
	private final IElementComponent elementComponent;

	protected final Combo getSwitchCombo() {
		return switchCombo;
	}

	protected final void setSwitchCombo(final Combo switchCombo) {
		this.switchCombo = switchCombo;
	}

	protected final PageBook getPageBook() {
		return pageBook;
	}

	protected final void setPageBook(final PageBook pageBook) {
		this.pageBook = pageBook;
	}

	protected final ISyntaxComponent getSyntaxComponent() {
		return syntaxComponent;
	}

	protected final IElementComponent getElementComponent() {
		return elementComponent;
	}

	/**
	 * @param syntaxComponent
	 * @param elementComponent
	 */
	public SwitchComponent(final ISyntaxComponent syntaxComponent, final IElementComponent elementComponent) {
		this.syntaxComponent = syntaxComponent;
		this.elementComponent = elementComponent;
	}

	/**
	 *
	 */
	public void initialize() {
		switchCombo.addSelectionListener(this);
		elementComponent.initialize();
		syntaxComponent.initialize();
		restoreSelection();
	}

	abstract public void createContents(final int numColumns, final Composite parent);

	/**
	 *
	 */
	abstract protected void restoreSelection();
}